Tasks: Improve Documentation

SECTION II: Improve Documentation

Task Description:

In this section, you will be improving the documentation associated with your project.

For this part, you will want to be a little familiar with markdown. For the most part, you can use regular text within a markdown file, but there are some easy ways to make the file more aesthetically appealing (bold, italic, headers, lists). There are resources at the bottom of this page if you need some assistance.

Follow the tasks here to update your project documentation.

Task List:

Create a branch named * documentation* on your local repository.

Switch to the * documentation* branch.

Update the README.md file to be consistent with the work you did in the Bikeshare project.

Stage your changes.

Commit your work with a descriptive message of the changes made.

Push your commits to the remote repository branch. Here is a link about how often you should push your commits that may be helpful when determining how often to push.

Switch back to the * master* branch.

Go to GitHub. Notice that you now have two branches available for your project, and when you change branches the README changes.

Task Feedback:

Great! Now you are off to a great start with setting up your documentation.

SECTION III: Additional Changes to Documentation

Task Description:

In a real world situation, you or other members of your team would likely be making other changes to documentation on the documentation branch. To simulate this follow the tasks below.

Task List:

Switch to the * documentation* branch on your local repository.

Make at least 2 additional changes to the documentation - this might be additional changes to the README or changes to the document strings and line comments of the bikeshare file.

After each change, stage and commit your changes to YOUR OWN repo in your own Github account. When you commit your work, you should use a descriptive message of the changes made. Your changes should be small and aligned with your commit message.

Push your changes to the remote repository branch in your OWN repo.

Switch back to the * master* branch in your own repo.

Check the local repository log to see how all the branches have changed.

Go to GitHub. Notice how many commits exist on the master branch and how many exist on the documentation branch.

Task Feedback:

Nice, you are done with the changes related to documentation!

If you are not familiar with Markdown, there are several online resources available to work in Markdown files. On Atom, you can use ctrl + shift + m to preview your markdown as you work on it. Here are some useful websites to quickly get up to speed for how to use Markdown.

There is no one way to write a README file, however there are some general conventions for what it should include.

General description of the project or content of the repository.
List of what software, firmware and hardware you may require.
Installation instructions for the software and firmware.
List of files included in the project.
Copyright and licensing information.
Acknowledgements and credits for any resources or blogs that helped you create the project.
Known bugs
Log of updates and revisions.

You can see some useful documentation on README files on this GitHub resource located here.